home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / X11 / XAllocWMHints.z / XAllocWMHints
Encoding:
Text File  |  1998-10-30  |  10.7 KB  |  241 lines
  1.  
  2.  
  3.  
  4.      XXXXAAAAllllllllooooccccWWWWMMMMHHHHiiiinnnnttttssss((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333)))) XXXXAAAAllllllllooooccccWWWWMMMMHHHHiiiinnnnttttssss((((3333XXXX11111111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XAllocWMHints, XSetWMHints, XGetWMHints, XWMHints - allocate
  10.           window manager hints structure and set or read a window's
  11.           WM_HINTS property
  12.  
  13.      SSSSYYYYNNNNTTTTAAAAXXXX
  14.           XWMHints *XAllocWMHints()
  15.  
  16.           XSetWMHints(_d_i_s_p_l_a_y, _w, _w_m_h_i_n_t_s)
  17.                 Display *_d_i_s_p_l_a_y;
  18.                 Window _w;
  19.                 XWMHints *_w_m_h_i_n_t_s;
  20.  
  21.  
  22.           XWMHints *XGetWMHints(_d_i_s_p_l_a_y, _w)
  23.                 Display *_d_i_s_p_l_a_y;
  24.                 Window _w;
  25.  
  26.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  27.           _d_i_s_p_l_a_y   Specifies the connection to the X server.
  28.  
  29.           _w         Specifies the window.
  30.  
  31.           _w_m_h_i_n_t_s   Specifies the _X_W_M_H_i_n_t_s structure to be used.
  32.  
  33.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  34.           The _X_A_l_l_o_c_W_M_H_i_n_t_s function allocates and returns a pointer
  35.           to a _X_W_M_H_i_n_t_s structure.  Note that all fields in the
  36.           _X_W_M_H_i_n_t_s structure are initially set to zero.  If
  37.           insufficient memory is available, _X_A_l_l_o_c_W_M_H_i_n_t_s returns
  38.           NULL.  To free the memory allocated to this structure, use
  39.           _X_F_r_e_e.
  40.  
  41.           The _X_S_e_t_W_M_H_i_n_t_s function sets the window manager hints that
  42.           include icon information and location, the initial state of
  43.           the window, and whether the application relies on the window
  44.           manager to get keyboard input.
  45.  
  46.           _X_S_e_t_W_M_H_i_n_t_s can generate _B_a_d_A_l_l_o_c and _B_a_d_W_i_n_d_o_w errors.
  47.  
  48.           The _X_G_e_t_W_M_H_i_n_t_s function reads the window manager hints and
  49.           returns NULL if no WM_HINTS property was set on the window
  50.           or returns a pointer to a _X_W_M_H_i_n_t_s structure if it succeeds.
  51.           When finished with the data, free the space used for it by
  52.           calling _X_F_r_e_e.
  53.  
  54.           _X_G_e_t_W_M_H_i_n_t_s can generate a _B_a_d_W_i_n_d_o_w error.
  55.  
  56.      PPPPRRRROOOOPPPPEEEERRRRTTTTIIIIEEEESSSS
  57.           WM_HINTS  Additional hints set by the client for use by the
  58.                     window manager.  The C type of this property is
  59.                     _X_W_M_H_i_n_t_s.
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXAAAAllllllllooooccccWWWWMMMMHHHHiiiinnnnttttssss((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333)))) XXXXAAAAllllllllooooccccWWWWMMMMHHHHiiiinnnnttttssss((((3333XXXX11111111))))
  71.  
  72.  
  73.  
  74.      SSSSTTTTRRRRUUUUCCCCTTTTUUUURRRREEEESSSS
  75.           The _X_W_M_H_i_n_t_s structure contains:
  76.  
  77.           /* Window manager hints mask bits */
  78.           #define
  79.                     _I_n_p_u_t_H_i_n_t
  80.                                                 (1L << 0)
  82.           #define
  83.                     _S_t_a_t_e_H_i_n_t
  84.                                                 (1L << 1)
  86.           #define
  87.                     _I_c_o_n_P_i_x_m_a_p_H_i_n_t
  88.                                                 (1L << 2)
  90.           #define
  91.                     _I_c_o_n_W_i_n_d_o_w_H_i_n_t
  92.                                                 (1L << 3)
  94.           #define
  95.                     _I_c_o_n_P_o_s_i_t_i_o_n_H_i_n_t
  96.                                                 (1L << 4)
  98.           #define
  99.                     _I_c_o_n_M_a_s_k_H_i_n_t
  100.                                                 (1L << 5)
  102.           #define
  103.                     _W_i_n_d_o_w_G_r_o_u_p_H_i_n_t
  104.                                                 (1L << 6)
  106.           #define
  107.                     _U_r_g_e_n_c_y_H_i_n_t
  108.                                                 (1L << 8)
  110.           #define
  111.                     _A_l_l_H_i_n_t_s
  112.                                                 (InputHint|StateHint|IconPixmapHint|
  113.                                                 IconWindowHint|IconPositionHint|
  114.                                                 IconMaskHint|WindowGroupHint)
  116.  
  117.  
  118.           /* Values */
  119.  
  120.           typedef struct {
  121.                long flags;         /* marks which fields in this structure are defined */
  122.                Bool input;         /* does this application rely on the window manager to
  123.                                    get keyboard input? */
  124.                int initial_state;  /* see below */
  125.                Pixmap icon_pixmap; /* pixmap to be used as icon */
  126.                Window icon_window; /* window to be used as icon */
  127.                int icon_x, icon_y; /* initial position of icon */
  128.                Pixmap icon_mask;   /* pixmap to be used as mask for icon_pixmap */
  129.                XID window_group;   /* id of related window group */
  130.                /* this structure may be extended in the future */
  131.           } XWMHints;
  132.  
  133.           The input member is used to communicate to the window
  134.           manager the input focus model used by the application.
  135.           Applications that expect input but never explicitly set
  136.           focus to any of their subwindows (that is, use the push
  137.           model of focus management), such as X Version 10 style
  138.           applications that use real-estate driven focus, should set
  139.           this member to _T_r_u_e.  Similarly, applications that set input
  140.           focus to their subwindows only when it is given to their
  141.           top-level window by a window manager should also set this
  142.           member to _T_r_u_e.  Applications that manage their own input
  143.           focus by explicitly setting focus to one of their subwindows
  144.           whenever they want keyboard input (that is, use the pull
  145.           model of focus management) should set this member to _F_a_l_s_e.
  146.           Applications that never expect any keyboard input also
  147.           should set this member to _F_a_l_s_e.
  148.  
  149.           Pull model window managers should make it possible for push
  150.           model applications to get input by setting input focus to
  151.           the top-level windows of applications whose input member is
  152.           _T_r_u_e.  Push model window managers should make sure that pull
  153.           model applications do not break them by resetting input
  154.           focus to _P_o_i_n_t_e_r_R_o_o_t when it is appropriate (for example,
  155.  
  156.  
  157.  
  158.      Page 2                                          (printed 4/30/98)
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.      XXXXAAAAllllllllooooccccWWWWMMMMHHHHiiiinnnnttttssss((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333)))) XXXXAAAAllllllllooooccccWWWWMMMMHHHHiiiinnnnttttssss((((3333XXXX11111111))))
  166.  
  167.  
  168.  
  169.           whenever an application whose input member is _F_a_l_s_e sets
  170.           input focus to one of its subwindows).
  171.  
  172.           The definitions for the initial_state flag are:
  173.           #define
  174.                     _W_i_t_h_d_r_a_w_n_S_t_a_t_e
  175.                                            0
  177.           #define
  178.                     _N_o_r_m_a_l_S_t_a_t_e
  179.                                            1
  180.                                                 /* most applications start
  181.                                                 this way */
  183.  
  184.           #define
  185.                     _I_c_o_n_i_c_S_t_a_t_e
  186.                                            3
  187.                                                 /* application wants to
  188.                                                 start as an icon */
  190.  
  191.           The icon_mask specifies which pixels of the icon_pixmap
  192.           should be used as the icon. This allows for nonrectangular
  193.           icons.  Both icon_pixmap and icon_mask must be bitmaps.  The
  194.           icon_window lets an application provide a window for use as
  195.           an icon for window managers that support such use.  The
  196.           window_group lets you specify that this window belongs to a
  197.           group of other windows.  For example, if a single
  198.           application manipulates multiple top-level windows, this
  199.           allows you to provide enough information that a window
  200.           manager can iconify all of the windows rather than just the
  201.           one window.
  202.  
  203.           The _U_r_g_e_n_c_y_H_i_n_t flag, if set in the flags field, indicates
  204.           that the client deems the window contents to be urgent,
  205.           requiring the timely response of the user.  The window
  206.           manager will make some effort to draw the user's attention
  207.           to this window while this flag is set.  The client must
  208.           provide some means by which the user can cause the urgency
  209.           flag to be cleared (either mitigating the condition that
  210.           made the window urgent or merely shutting off the alarm) or
  211.           the window to be withdrawn.
  212.  
  213.      DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  214.           _B_a_d_A_l_l_o_c  The server failed to allocate the requested
  215.                     resource or server memory.
  216.  
  217.           _B_a_d_W_i_n_d_o_w A value for a Window argument does not name a
  218.                     defined Window.
  219.  
  220.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  221.           XAllocClassHint(3X11), XAllocIconSize(3X11),
  222.           XAllocSizeHints(3X11), XFree(3X11), XSetCommand(3X11),
  223.           XSetTransientForHint(3X11), XSetTextProperty(3X11),
  224.           XSetWMClientMachine(3X11), XSetWMColormapWindows(3X11),
  225.           XSetWMIconName(3X11), XSetWMName(3X11),
  226.           XSetWMProperties(3X11), XSetWMProtocols(3X11),
  227.           XStringListToTextProperty(3X11)
  228.           _X_l_i_b - _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.      Page 3                                          (printed 4/30/98)
  238.  
  239.  
  240.  
  241.